Add @unique decorator that ignores deprecated enum members
#96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Leandro Lucarella <[email protected]>
This commit introduces a new `@unique` decorator in the `frequenz.core.enum` module that ensures uniqueness among enum members, excluding those marked as deprecated. This allows deprecated members to serve as aliases for non-deprecated members without causing a `ValueError`. Signed-off-by: Leandro Lucarella <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Introduces a new @unique decorator in the frequenz.core.enum module that enforces uniqueness only among non-deprecated enum members, allowing deprecated members to serve as aliases without raising ValueError.
Key Changes
- Added
uniquedecorator function that ignores deprecated members when checking for duplicate values - Comprehensive test suite covering various scenarios including deprecated aliases, duplicates, and edge cases
- Updated release notes with examples demonstrating the new functionality
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frequenz/core/enum.py | Implements the new unique decorator with logic to skip deprecated members during uniqueness validation |
| tests/test_enum.py | Adds comprehensive test coverage for the unique decorator across multiple scenarios |
| RELEASE_NOTES.md | Documents the new feature with usage examples and comparison to standard library behavior |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
github-actions
bot
added
part:docs
llucax
added
type:enhancement
Marenz
approved these changes
Sep 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a new
@uniquedecorator in thefrequenz.core.enummodule that ensures uniqueness among enum members, excluding those marked as deprecated. This allows deprecated members to serve as aliases for non-deprecated members without causing aValueError.